home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
IRIX Base Documentation 1998 November
/
IRIX 6.5.2 Base Documentation November 1998.img
/
usr
/
share
/
catman
/
p_man
/
cat3
/
PDMakeMessage.z
/
PDMakeMessage
Wrap
Text File
|
1998-10-30
|
3KB
|
67 lines
PPPPDDDDMMMMaaaakkkkeeeeMMMMeeeessssssssaaaaggggeeee((((3333)))) IIIImmmmpppprrrreeeessssssssaaaarrrriiiioooo PPPPDDDDMMMMaaaakkkkeeeeMMMMeeeessssssssaaaaggggeeee((((3333))))
NNNNAAAAMMMMEEEE
PDMakeMessage - message creation convenience function
SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
####iiiinnnncccclllluuuuddddeeee <<<<ppppoooodddd....hhhh>>>>
iiiinnnntttt PPPPDDDDMMMMaaaakkkkeeeeMMMMeeeessssssssaaaaggggeeee((((PPPPDDDDMMMMeeeessssssssaaaaggggeeeeSSSSttttrrrruuuucccctttt ****mmmmeeeessssssssaaaaggggeeee,,,, iiiinnnntttt ccccooooddddeeee))));;;;
DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
_P_D_M_a_k_e_M_e_s_s_a_g_e is a convenience function for filling a _P_D_M_e_s_s_a_g_e_S_t_r_u_c_t
structure. This function is useful when building an array of messages for
use with the _P_D_L_o_c_a_l_W_r_i_t_e_S_t_a_t_u_s function.
_P_D_M_a_k_e_M_e_s_s_a_g_e fills the structure pointed to by _m_e_s_s_a_g_e with the message
code specified by _c_o_d_e. _c_o_d_e is one of the standard error, warning or
information codes defined in _p_o_d._h. The text field of the message
structure is automatically set to a standard message based on the value
of _c_o_d_e.
The _P_D_M_e_s_s_a_g_e_S_t_r_u_c_t is defined as follows.
typedef struct _pdMessageStruct {
int message_code;
char message_text[PD_STR_MAX];
} PDMessageStruct;
_m_e_s_s_a_g_e__c_o_d_e Error, warning or information message code ID (see
_p_o_d._h).
_m_e_s_s_a_g_e__t_e_x_t Text for the message truncated to a length of
PD_STR_MAX-1.
RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
0 is returned if execution was successful. -1 is returned and _P_D_e_r_r_n_o is
set if an execution error has occurred.
EEEEXXXXEEEECCCCUUUUTTTTIIIIOOOONNNN EEEERRRRRRRROOOORRRR CCCCOOOODDDDEEEESSSS
_P_D_M_a_k_e_M_e_s_s_a_g_e will fail under the following circumstances.
PD_LIBERR_BAD_STRUCT A NULL structure pointer has been specified.
PD_LIBERR_BAD_MSG An invalid message code has been specified.
Valid message codes are listed in _p_o_d._h.
SSSSEEEEEEEE AAAALLLLSSSSOOOO
PDReadStatus(3), libpod(3)
PPPPaaaaggggeeee 1111